/*
 * ----------------------------------------------------------------------------
 *  (C) Copyright Testing Technologies, 2001-2006.  All Rights Reserved.
 *
 *  All copies of this program, whether in whole or in part, and whether
 *  modified or not, must display this and all other embedded copyright
 *  and ownership notices in full.
 *
 *  See the file COPYRIGHT for details of redistribution and use.
 *
 *  You should have received a copy of the COPYRIGHT file along with
 *  this file; if not, write to the Testing Technologies,
 *  Rosenthaler Str. 13, 10119 Berlin, Germany.
 *
 *  TESTING TECHNOLOGIES DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS
 *  SOFTWARE. IN NO EVENT SHALL TESTING TECHNOLOGIES BE LIABLE FOR ANY
 *  SPECIAL, DIRECT, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
 *  WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN
 *  AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,
 *  ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF
 *  THIS SOFTWARE.
 *
 *  THE SOFTWARE IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND,
 *  EITHER EXPRESSED OR IMPLIED, INCLUDING ANY KIND OF IMPLIED OR
 *  EXPRESSED WARRANTY OF NON-INFRINGEMENT OR THE IMPLIED WARRANTIES
 *  OF MECHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
 *
 * ----------------------------------------------------------------------------
 *
 *  AUTHOR:      Alex Lorenz
 *  DATE:        January, 2006
 *
 *  REVISION INFO:
 *    $Revision: 1.1 $ $Date: 2006/01/06 14:46:58 $
 *    $Source: /usr/local/cvs_root/TTthree/javasrc/org/etsi/ttcn/tci/TciStatus.java,v $
 *
 * ----------------------------------------------------------------------------
 */
package org.etsi.ttcn.tci;

/** 
    A value of type TriStatusType is either TRI_OK or TRI_Error
    indicating the success or failure of a TRI operation.
 */
public interface TciStatus {
    /** Indicates local success of a TRI operation
     */
    public final static int TCI_OK      =  0;
    /** Indicates local failure of a TRI operation
     */
    public final static int TCI_ERROR   = -1;

    /** Returns the string representation of the status.
     */
    public String  toString();

    /** Returns the status of this TriStatus.
     */
    public int     getStatus();

    /** Sets the status of this TriStatus.
     */
    public void    setStatus(int status);

    /** Compares status with this TriStatus for equality. Returns true
    if and only if they have the same status, false otherwise.
    */
    public boolean equals(TciStatus status);
}
